------------------------------------------------------------------------------------------------
 Zweck   : Zustzliche Navigationsmen-Befehle zum Sprungantrieb
 Version :  7.01   vom 14.04.2011
 X2      : Version 1.4/1.5 (Patch 1.4 oder 1.5)
 Engine  : Scriptengine Version 25
 Autor   : SpaceTycoon (im Userforum von www.egosoft.de)
 Dateien : setup.plugin.navsoftwareST1.xml	: Ld Textfile, installiert Erweiterung
			remove.plugin.navsoftwareST1.xml	: Entfernt die Ware aus dem Spiel
			plugin.navsoftwareST1.jumpDck.pl.xml	: In gewhlte Station/Carrier mit Sprungantrieb  
           plugin.navsoftwareST1.jumpPos.pl.xml	: Zur gewhlten Sektorposition mit Sprungantrieb
           plugin.navsoftwareST1.jump           : Hauptscript fr Jump (Drei Argumente!)
           plugin.navsoftwareST1.sound          : Script fr Sound und Sprachausgabe
            497776.xml							: Deutsche Sprachdatei fr Funktionen und Meldungen 
            447776.xml							: Englische Sprachdatei
           README GER- Navigationssoftware ST1.txt: German manual for the script
           README ENG- Navigation Software ST1.txt: English manual for the script
            x2script.xsl			: Gendertes Stylesheet im Ordner \scripts
                                       zum besseren Lesen und Drucken von Scripten

 Weitere Infos zur Software sind im Internet im Egosoft Userforum unter der URL

         http://www.egosoft.com/x2/forum/viewtopic.php?t=43508

 nachzulesen. Oder auch, um Fragen dazu zu stellen.


 Nachstehend folgen die Textabschnitte:
  "Installation", "Verwendung", "Deinstallation", "Haftungsauschluss", "Info fr Programmierer"
------------------------------------------------------------------------------------------------

Installation: 
 Die obigen "..navsoftwareST1"-xml-Dateien alle im Ordner "scripts" des Spieles ablegen.
 Die obigen Sprachdateien "4x7776.xml" in einem Ordner "t" innerhalb des Spieleordners
 ablegen. Falls evtl. noch kein Ordner "t" besteht, diesen Ordner erstellen.
 Das Ablegen am richtigen Ort geschieht bei Entpacken *mit Pfad* automatisch.

 Der Scripteditor mu aktiviert sein (im Spiel ist in diesem Fall oben links schwach
 das Wort "modified" zu sehen), damit die Erweiterung funktioniert!
 Falls nicht aktiviert:
  - Mit dem Schiff irgendwo im Weltraum
  - Schiff in Bereitschaft setzen (SHIFT-C, dann Navigation - "In Bereitschaft")
  - Nun die Tastenkombination  T h e r e s h a l l b e w i n g s   tippen
    (ohne Leerstellen und mit groem "T", Rest Kleinbuchstaben)
  - Im Spiel wird oben links nun schwach ein "modified" angezeigt.
  - Falls nicht 'modified' (es geht irgendein Men auf oder so), nochmal tippen!
    Es ist empfehlenswert, eher langsamer als zu schnell zu tippen!
  - Nun abspeichern (in Station oder mit Bergungsversicherung) und mit SHIFT-Q
    zurck ins Hauptmen und neu laden (der Zustand "modified" wird im Spielstand
    mit abgespeichert).
  - Die Erweiterung wird beim Laden eines Spielstandes im "modified"-Modus nun
    automatisch initialisiert.
------------------------------------------------------------------------------------------------
 
Verwendung:
 In allen Ausrstungsdocks, Hauptquartieren und Piratendocks gibt es nun die neue
 Software "Navigationssoftware ST1" zum Preis von nur 1.572 Credits zu kaufen.
 Die ebenfalls angebotene Navigationssoftware MK1 zustzlich zu kaufen, ist
 fr die Funktion dieser Erweiterung nicht erforderlich!

 Die Software kann auf smtlichen Schiffen installiert werden. Danach sind in
 der Kommandokonsole des Schiffes im Navigationsmen neue Befehle zu finden:
 "Sprung und Andocken" und "Sprung an Position".
 Mit installiertem Sprungantrieb kann damit ein Schiff ferngesteuert zum
 Springen in ein anderes System und andocken (oder Position anfliegen)
 veranlat werden. Diese Erweiterung funktioniert im Spielerschiff genauso
 wie in ferngesteuerten Schiffen.

 Die Funktion "Sprung und Andocken" funktioniert bei groen Trgerschiffen nur
 fr eine Schiffswerft, da diese Schiffe nicht in eine Station oder in ein
 anderes Trgerschiff einfliegen knnen.
 Grundstzlich mu man beim Starten des Sprungantriebes ber das Navigations-
 men den Countdown bis 100% abwarten - das ist auch beim Befehl "Sprung" der
 im Spiel standardmig vorhandenen Navigationssoftware MK1 so.

 Die fr den Sprung notwendigen Energiezellen werden automatisch geladen und
 das dafr ntige Geld (16 Cr. pro Energiezelle) dem Spielerkonto abgezogen.
 Allerdings mu dafr auch der Laderaum des Schiffes gro genug sein,
 um die ntigen EZ zu laden!
 
 Sonderfunktionen:
 Remote befehligte Schiffe geben eine Nachricht ins Spieler Log, wenn sie am
 Ziel angekommen sind.
 Dies ist abschaltbar durch Installation des SINZA auf diesen Schiffen.
 Jedes Schiff mit installiertem SINZA meldet KEINE Ankunft mehr!
 Wenn man Meldungen wieder haben will, einfach SINZA aus dem Frachtraum werfen.
 
 Kurzsprung innerhalb eines Sektors zu einer gewhlten Station oder Position.
 Direkt innerhalb eines Sektors oder auch direkt nach dem Sprung in einen
 anderen Sektor. VORAUSSETZUNG: Das Schiff hat die Boost Erweiterung installiert.
 Soll ein Schiff diesen Kurzprung nicht durchfhren, die Boost-Erweiterung
 einfach aus dem Frachtraum des Schiffes auswerfen.
 Achtung! Mit Kurzsprung-Fhigkeit kostet ein Sprung zustzliche 120 Credits.
 Anders gesagt, ein Kurzsprung innerhalb eines Sektors bentigt auch den
 Sprungantrieb und zustzlich die Boost-Erweiterung im Schiff. Und kostet dann
 120 Credits fr jeden Kurzsprung. Das Geld wird vom Spielerkonto abgezogen,
 oder vom Konto der Homebase wenn das Schiff eine Homebase hat.
 

 Weitere Infos:  http://www.egosoft.com/x2/forum/viewtopic.php?t=43508

------------------------------------------------------------------------------------------------

Deinstallation:
 Die Software kann von allen Stationen und Schiffen, wo sie installiert ist,
 wieder entfernt werden. Hierzu mu der Scripteditor aufgerufen werden
 (SHIFT-C und "S") und in der Liste der Scripte das Script
     "remove.plugin.navsoftwareST1" markiert werden.
 Dann Taste "r" drcken und alles danach mit Eingabetaste besttigen um das
 Script auszufhren - bis die Liste der Scripte wieder erscheint. Danach ist die
 Software  wieder aus der Liste der Gter in den Ausrstungsdocks, etc. entfernt.
 Hiernach mu das Spiel gespeichert werden!
 Dann Spiel beenden und die Sprachdateien 4x7776.xml im Ordner "t" sowie die
 obenstehenden xml-Dateien im Ordner "scripts" lschen, bevor das Spiel neu
 geladen wird.
 Wenn man zu einem alten Spielstand zurckkehrt, in dem diese Erweiterung noch
 vorhanden war, wird (wegen des nun fehlenden Sprachfiles) anstelle der Ware in den
 Stationen und Schiff "ReadText17-5783" angezeigt. Dies lt sich nicht verhindern,
 da die Ausstattung des Schiffes und das Warenangebot der Stationen im
 Spielstand mit abgespeichert werden.
 Falls im Frachtmen eines Schiffes nun noch eine Ware mit dem Namen "ReadText17-5793"
 aufgefhrt sein sollte, kann diese ausgeworfen und abgeschossen werden :-)
------------------------------------------------------------------------------------------------

Disclaimer:
 Trotzt uerster Sorgfalt beim Programmieren wird keinerlei Haftung bernommen fr:
 Fehlerhafte Spielstnde, nicht ordnungsgeme Spielfunktion, nicht ordnungsgeme
 Funktion der Erweiterung und anderes. Nutzung auf eigene Gefahr und Risiko.
------------------------------------------------------------------------------------------------

Info fr Programmierer:
 Das init-script setzt eine Globale Variable "NavSoftST1" mit dem Wert der Versionsnummer.
 Diese kann von fremden Scripten abgefragt werden, um das Vorhandensein des Scripts
 festzustellen - egal ob die Ware in einem Schiff eingebaut ist oder nicht.
 Mchte man in einem Script in Abhngigkeit von der eingebauten Erweiterung jumpen
 oder nicht, kann das mit  "get true amount of ware Navigationssoftware ST1 in cargo"
 geprft werden.
                            --------------------------
 Das Hauptscript "plugin.navsoftwareST1.jump" kann von fremden Scripten per call
 aufgerufen werden. Hierbei sind folgende vier Parameter (Argumente) mglich:
  Sector Position - Array : Die Sektorposition als Array mit 4 Werten: x,y,z,Sector
  Station or Ship to dock at: Station oder Schiff zum Andocken nach dem Jump
  Target Warpgate: Ein Sprungtor (oder Sektor, fr die Mitte des Sektors)
  ** Eines dieser drei Argumente muss angegeben werden - andernfalls wird
     nichts ausgefhrt und ins aufrufende Script zurckgesprungen.
     Hierbei wird der Wert FLRET_INVALIDPARMS ans Aufrufscript zurckgegeben.
     Bei Angabe eines Sprungzieles "Position" oder "Station" wird das naheste
     Sprungtor vor dem Sprung errechnet, dort kommt das Schiff dann raus.
  With Escortships-TRUE or FALSE: Hier kann durch TRUE bestimmt werden, da die
     Begleitschiffe mitspringen. Wird null oder FALSE gesetzt, springt nur
     das gewhlte Schiff alleine.

 Nach erfolgreichem Jump gibt das JumpScript an das aufrufende Script den Wert
 FLRET_WARPED (oder FLRET_TARGETREACHED bei Kurzsprung) zurck. Dieser kann vom
 Aufrufscript dann zur Weiterverarbeitung ausgewertet werden.
 Als Beispiele fr das Auswerten der ReturnCodes knnen die beiden Playerscripte
 (.pl) angesehen werden.
 Wird Sektorkurzsprung verwendet, so ist die Rckmeldung: FLRET_TARGETREACHED.

 Das Hauptscript kann noch einen weiteren Wert zurckgeben: FLRET_ERROR.
 Dieser wird zurckgegeben, wenn das Schiff keinen funktionierenden Jumpdrive
 und/oder nicht gengend oder keine Energiezellen an Bord hat.

 Noch mal kurz die Funktionen des Hauptscriptes:
 - Auswertung der bergebenen *notwendigen* Argumente
 - berprfung, ob eines der drei og. Hauptargumente gesetzt ist.
   = Falls nicht, zurck zum Callscript mit Rckgabewert: FLRET_INVALIDPARMS
 - berprfung auf Sprungmglichkeit (Antrieb/Energie).
   = Falls nicht, zurck zum Callscript mit Rckgabewert: FLRET_ERROR
 - berprfung, ob das Schiff angedockt ist.
   = Falls ja, wird nun erstmal von Station abgeflogen.
 - Errechnen des besten (nchstgelegenen) Sprungtores zum Ziel.
 - berprfung, ob mit Begleitschiffen gesprungen werden soll oder nicht.
   Falls ja, ob es berhaupt Begleitschiffe gibt. Veranlassung der Begleitschiffe,
   wiederum mit Ihren Begleitschiffen zum selben Tor zu springen.
 - Sprung. Abwarten von 3500 ms (Ship verlt in der Zeit das Sprungtor).
 - Ausgang mit Rckgabewert: FLRET_WARPED.
                            --------------------------     
 Ich verwende fr mein Textfile die unbenutzte ID 7776. Und innerhalb des
 Textfiles fr die Fehlertexte und Sprache die Page-ID 7777. Die Erweiterung
 verwendet fr die Ware "ReadText17-5783" und fr die Kommandos die Befehle
 "COMMAND_TYPE_NAV_30" und "COMMAND_TYPE_NAV_31". Mit Hilfe des Sprachfiles werden
 beide COMMAND-Types umgemappt zu "CMD_ST_JUMP_AND_DOCK" und "CMD_ST_JUMP_TO_POSITION".
 Innerhalb des Script-Editors sind dann unter den Commands die beiden NAV_30 und NAV_31
 genausowenig zu finden (und knnen dann irrtmlich auch nicht mehr benutzt werden)
 wie unter den Waren der ReadText17-5783. Da diese drei Dinge mittels des
 Sprachfiles umgemappt worden sind, sind sie im Script-Editor mit Ihren Bezeich-
 nungen aus dem Sprachfile (die jederzeit nderbar sind) zu finden (Ware/Commands).
 Der im Sprachfile zu sehende Tag  <t id="5784">{17,5665}</t> mappt die Sprach-
 und Textinformation aus dem Einkaufsmen des Ausrstungsdocks auf den von
 der Erweiterung neu erzeugten Eintrag. So da nach Markierung der Ware im Dock
 (oder auch nach Auswerfen aus dem Frachtraum im All) diese vom Computer erklrt wird.

---- Ende der Dokumentation --------------------------------------------------------------------